# 1.Job
## Authentication
Set HTTP header
```
Authorization: Bearer {API key}
Content-Type: application/json
```
### Response Body details
```
0: Succeed
1: Fail
2: No response
```
## GET /api/v1/jobs
List jobs
### Response Body
``` json
[
{
"id": "JOBF12E05983DF7490AAA648F1495321CDF",
"reference_id": "JOBF12E05983DF7490AAA648F1495321CDF",
"created_at": 1594636151,
"title": "test search",
"description": "xxx",
"compensation_rate": 111,
"compensation_type": {
"id": 1,
"name": {
"en": "Per hour",
"jp": "時給"
}
},
"slug": null,
"prefecture": {
"en": "HYOGO KEN",
"jp": "兵庫県"
},
"city": {
"en": "",
"jp": ""
},
"duration": {
"id": 1,
"name": {
"en": "Under 1 week",
"jp": "1週間以内"
}
},
"category": {
"en": "Engineer / Digital Design",
"jp": "エンジニア・クリエイター"
},
"company": {
"name": "House Builder",
"id": "CPN_GCHFLD7TZ3TJVVIVZ3JNEV4I3BK7F5MFF733Z44UL4OHLDAZK44MCRIB"
},
"signed": 0,
"user_id": "USC_GCKAKQNAVQVRCI6G3A5T6IIARCK6CJ33M6SUS72RSWEBJ7WP2FELXWRD",
"languages": [],
"work_remotely": 0,
"start": 1594636125,
"end": 1594771200
},
{
"id": "JOB4CACB16484D346D6B9831A37966C0941",
"reference_id": "JOB4CACB16484D346D6B9831A37966C0941",
"created_at": 1594434296,
"title": "test new payment flow 8",
"description": "x",
"compensation_rate": 1111,
"compensation_type": {
"id": 1,
"name": {
"en": "Per hour",
"jp": "時給"
}
},
"slug": null,
"prefecture": {
"en": "MIE KEN",
"jp": "三重県"
},
"city": {
"en": "INABE SHI",
"jp": "いなべ市"
},
"duration": {
"id": 1,
"name": {
"en": "Under 1 week",
"jp": "1週間以内"
}
},
"category": {
"en": "Office Work",
"jp": "事務・オフィスワーク"
},
"company": {
"name": "House Builder",
"id": "CPN_GCHFLD7TZ3TJVVIVZ3JNEV4I3BK7F5MFF733Z44UL4OHLDAZK44MCRIB"
},
"signed": 0,
"user_id": "USC_GCKAKQNAVQVRCI6G3A5T6IIARCK6CJ33M6SUS72RSWEBJ7WP2FELXWRD",
"languages": [],
"work_remotely": 0,
"start": 1593302400,
"end": 1593561600
},...
]
```
## GET /api/v1/jobs/{jobID} or {referenceID}
Get a job by id or referenceID
### Response Body
``` json
{
"id": "JOBF12E05983DF7490AAA648F1495321CDF",
"reference_id": "JOBF12E05983DF7490AAA648F1495321CDF",
"title": "test search",
"description": "xxx",
"compensation_rate": 111,
"compensation_type": {
"id": 1,
"name": {
"en": "Per hour",
"jp": "時給"
}
},
"slug": null,
"created_at": 1594636151,
"user": {
"id": "USC_GCKAKQNAVQVRCI6G3A5T6IIARCK6CJ33M6SUS72RSWEBJ7WP2FELXWRD",
"given_name": "support",
"family_name": "company1",
"img": null
},
"prefecture": {
"en": "HYOGO KEN",
"jp": "兵庫県"
},
"city": {
"en": "",
"jp": ""
},
"duration": {
"id": 1,
"name": {
"en": "Under 1 week",
"jp": "1週間以内"
}
},
"category": {
"en": "Engineer / Digital Design",
"jp": "エンジニア・クリエイター"
},
"company": {
"name": "House Builder",
"id": "CPN_GCHFLD7TZ3TJVVIVZ3JNEV4I3BK7F5MFF733Z44UL4OHLDAZK44MCRIB"
},
"signed": 0,
"user_id": "USC_GCKAKQNAVQVRCI6G3A5T6IIARCK6CJ33M6SUS72RSWEBJ7WP2FELXWRD",
"img": "",
"languages": [],
"work_remotely": 0,
"start": 1594636125,
"end": 1594771200,
"files": []
}
```
## POST /api/v1/jobs
Create a job
### Request Body
#### One job
``` json
{
"reference_id": "JOBF12E05983DF7490AAA648F1495321CDF",
"title": "title",
"description": "description",
"category": {
"id": 1
},
"prefecture": {
"id": 5
},
"city": {
"id": 63
},
"work_remotely": false,
"compensationType": {
"id": 1
},
"compensationRate": 10000,
"files": []
}
```
#### Many jobs
``` json
[{
"reference_id": "JOBF12E05983DF7490AAA648F1495321CDF",
"title": "title1",
"description": "description",
"category": {
"id": 1
},
"prefecture": {
"id": 5
},
"city": {
"id": 63
},
"work_remotely": false,
"compensationType": {
"id": 1
},
"compensationRate": 10000,
"files": []
},
{
"reference_id": "JOB4CACB16484D346D6B9831A37966C0941",
"title": "title2",
"description": "description",
"category": {
"id": 1
},
"prefecture": {
"id": 5
},
"city": {
"id": 63
},
"work_remotely": false,
"compensationType": {
"id": 1
},
"compensationRate": 10000,
"files": []
}
]
```
### Response Body
```
0
```
## PUT /api/v1/jobs/{jobID} or {referenceID}
Update a job
### Request Body
``` json
{
"title": "title",
"description": "description",
"category": {
"id": 1
},
"prefecture": {
"id": 5
},
"city": {
"id": 63
},
"work_remotely": false,
"compensationType": {
"id": 1
},
"compensationRate": 10000,
"files": []
}
```
### Response Body
```
0
```
## DELETE /api/v1/jobs/{jobID} or {referenceID}
Delete a job
### Response Body
```
0
```
# 2.Categories
## GET /api/v1/categories
API List categories
#### Response Body
```json
{
"code": 200,
"result": {
"data": [{
"id": 1,
"name": {
"jp": "エンジニア・クリエイター",
"en": "Engineer / Digital Design"
},
"icon": "./static/icons/categories/engineer.png"
},
{
"id": 2,
"name": {
"jp": "事務・オフィスワーク",
"en": "Office Work"
},
"icon": "./static/icons/categories/admin.png"
},
{
"id": 3,
"name": {
"jp": "単純作業",
"en": "Physical Work"
},
"icon": "./static/icons/categories/physical.png"
},
{
"id": 4,
"name": {
"jp": "マネジメント",
"en": "Management"
},
"icon": "./static/icons/categories/management.png"
},
{
"id": 5,
"name": {
"jp": "セールスプロモーション",
"en": "Sales"
},
"icon": "./static/icons/categories/sales.png"
},
{
"id": 6,
"name": {
"jp": "カスタマーセンター",
"en": "Customer Services"
},
"icon": "./static/icons/categories/customer-service.png"
},
{
"id": 7,
"name": {
"jp": "データ入力",
"en": "Data Entry"
},
"icon": "./static/icons/categories/data-entry.png"
},
{
"id": 8,
"name": {
"jp": "その他",
"en": "Other"
},
"icon": "./static/icons/categories/other.png"
}
]
}
}
```
# 3.Regions
## GET /api/v1/regions
API List regions
#### Response Body
```json
{
"code": 200,
"result": {
"data": [{
"id": 1,
"name": {
"jp": "北海道",
"en": "Hokkaido"
}
},
{
"id": 2,
"name": {
"jp": "東北",
"en": "Tohoku"
}
},
{
"id": 3,
"name": {
"jp": "関東",
"en": "Kanto"
}
},
{
"id": 4,
"name": {
"jp": "中部",
"en": "Chubu"
}
},
{
"id": 5,
"name": {
"jp": "近畿",
"en": "Kinki"
}
},
{
"id": 6,
"name": {
"jp": "中国",
"en": "Chugoku"
}
},
{
"id": 7,
"name": {
"jp": "四国",
"en": "Shikoku"
}
},
{
"id": 8,
"name": {
"jp": "九州",
"en": "Kyusyu"
}
}
]
}
}
```
# 4.Prefectures
## GET /api/v1/prefectures
API List prefectures
#### Response Body
```json
{
"code": 200,
"result": {
"data": [{
"id": 1,
"name": {
"jp": "三重県",
"en": "MIE KEN"
}
},
{
"id": 2,
"name": {
"jp": "京都府",
"en": "KYOTO FU"
}
},
{
"id": 3,
"name": {
"jp": "佐賀県",
"en": "SAGA KEN"
}
},
...
]
}
}
```
# 5.Cities
## GET /api/v1/cities
API List cities
#### Response Body
```json
{
{
"code": 200,
"result": {
"data": [{
"id": 1,
"name": {
"jp": "あきる野市",
"en": "AKIRUNO SHI"
},
"prefectureId": 27
},
{
"id": 2,
"name": {
"jp": "あま市",
"en": "AMA SHI"
},
"prefectureId": 25
},
{
"id": 3,
"name": {
"jp": "あわら市",
"en": "AWARA SHI"
},
"prefectureId": 34
},
...
]
}
}
```
# 6.Compensation types
## GET /api/v1/compensationtypes
API List compensation types
#### Response Body
```json
{
"code": 200,
"result": {
"data": [{
"id": 1,
"name": {
"en": "Per hour",
"jp": "時給"
}
},
{
"id": 2,
"name": {
"en": "Project",
"jp": "プロジェクト"
}
}
]
}
}
```
# 7.Durations
## GET /api/v1/durations
API List durations
#### Response Body
```json
{
"code": 200,
"result": {
"data": [{
"id": 1,
"name": {
"en": "Under 1 week",
"jp": "1週間以内"
}
},
{
"id": 2,
"name": {
"en": "1 week to 3 months",
"jp": "1週間以上3ヶ月以内"
}
},
{
"id": 3,
"name": {
"en": "over 3 months",
"jp": "3ヶ月以上"
}
}
]
}
}
```